<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsecure: XilSecure Versal_2Ve_2Vm APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsecure
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xsecure__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilSecure Versal_2Ve_2Vm APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gab5e902adc4848c518fe177d0e880153e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__apis.html#gab5e902adc4848c518fe177d0e880153e">XSECURE_SHA_START</a>&#160;&#160;&#160;(0x1U)</td></tr>
<tr class="memdesc:gab5e902adc4848c518fe177d0e880153e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation flags for SHA start.  <a href="#gab5e902adc4848c518fe177d0e880153e">More...</a><br/></td></tr>
<tr class="separator:gab5e902adc4848c518fe177d0e880153e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga32a3242ed58e1b9bd426bf2c1b8b7b1f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__apis.html#ga32a3242ed58e1b9bd426bf2c1b8b7b1f">XSECURE_SHA_UPDATE</a>&#160;&#160;&#160;(0x2U)</td></tr>
<tr class="memdesc:ga32a3242ed58e1b9bd426bf2c1b8b7b1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation flags for SHA update.  <a href="#ga32a3242ed58e1b9bd426bf2c1b8b7b1f">More...</a><br/></td></tr>
<tr class="separator:ga32a3242ed58e1b9bd426bf2c1b8b7b1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6a8df6a5fe0b9fcd2a279d7b1383430f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__apis.html#ga6a8df6a5fe0b9fcd2a279d7b1383430f">XSECURE_SHA_FINISH</a>&#160;&#160;&#160;(0x4U)</td></tr>
<tr class="memdesc:ga6a8df6a5fe0b9fcd2a279d7b1383430f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation flags for SHA finish.  <a href="#ga6a8df6a5fe0b9fcd2a279d7b1383430f">More...</a><br/></td></tr>
<tr class="separator:ga6a8df6a5fe0b9fcd2a279d7b1383430f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7004972638c2036271d309af8ae5c351"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__apis.html#ga7004972638c2036271d309af8ae5c351">XSecure_ShaIpiHandler</a> (XPlmi_Cmd *Cmd)</td></tr>
<tr class="memdesc:ga7004972638c2036271d309af8ae5c351"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calls respective IPI handler based on the API_ID.  <a href="#ga7004972638c2036271d309af8ae5c351">More...</a><br/></td></tr>
<tr class="separator:ga7004972638c2036271d309af8ae5c351"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__apis.html#ga840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:ga840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the SecureAesExample.  <a href="#ga840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga6a8df6a5fe0b9fcd2a279d7b1383430f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSECURE_SHA_FINISH&#160;&#160;&#160;(0x4U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Operation flags for SHA finish. </p>

</div>
</div>
<a class="anchor" id="gab5e902adc4848c518fe177d0e880153e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSECURE_SHA_START&#160;&#160;&#160;(0x1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Operation flags for SHA start. </p>

</div>
</div>
<a class="anchor" id="ga32a3242ed58e1b9bd426bf2c1b8b7b1f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSECURE_SHA_UPDATE&#160;&#160;&#160;(0x2U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Operation flags for SHA update. </p>

<p>Referenced by <a class="el" href="group__xsecure__sha__client__apis.html#gad9611876471310e83eae5fc2ac640576">XSecure_Sha3Finish()</a>, and <a class="el" href="group__xsecure__sha__client__apis.html#ga66d0db1bbf860bc2247297ce63f398a2">XSecure_Sha3Update()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the SecureAesExample. </p>
<p>Main function to call the SecureShaExample.</p>
<p>This example illustrates the usage of RSA APIs to encrypt or decrypt the signature.</p>
<p>Main function to call the SecureRsaExample.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_FAILURE if the Test Failed .</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_FAILURE if the boot image authentication Failed .</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_FAILURE if the SHA calculation failed. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__apis.html#ga2b8b3f8c925d15be80cff15f248c1532">SecureAesExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7004972638c2036271d309af8ae5c351"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_ShaIpiHandler </td>
          <td>(</td>
          <td class="paramtype">XPlmi_Cmd *&#160;</td>
          <td class="paramname"><em>Cmd</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function calls respective IPI handler based on the API_ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Cmd</td><td>is pointer to the command structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS - If the handler execution is successful</li>
<li>ErrorCode - If there is a failure </li>
</ul>
</dd></dl>
<p>SHA IPI event handling </p>

<p>References <a class="el" href="group__xsecure__common__apis.html#ga2f4a1a99096821d10b0719a4ded431d5">XSECURE_API</a>, <a class="el" href="group__xsecure__common__apis.html#gaa2f27ea2d621bbdeda76bad8109eb77b">XSECURE_API_ID_MASK</a>, <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca7088fcfcdf82fc79ac3ebb1f3450b7ce">XSECURE_API_SHA2_OPERATION</a>, <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca37c744e7989bc792bb783c8ec670f647">XSECURE_API_SHA3_OPERATION</a>, <a class="el" href="group__xsecure__generic__server__apis.html#gac9c421c34d99194009679bdb4cf888ca">XSecure_GetSha2Instance()</a>, <a class="el" href="group__xsecure__generic__server__apis.html#gaae2c6ce911d390c5176b5b4b7ff5a4fb">XSecure_GetSha3Instance()</a>, <a class="el" href="group__xsecure__generic__server__apis.html#ga888b5fb720349f4766f1a6b45f318520">XSecure_IpiEventHandling()</a>, <a class="el" href="group__xsecure__generic__server__apis.html#gace2c73e5d80dd85a226551b02e396cc0">XSecure_MakeResFree()</a>, and <a class="el" href="group__xsecure__common__apis.html#ga693c54d224d1fa8ca68b215023b2b359">XSecure_Printf</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
